You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Jul 24, 2021. It is now read-only.
when clicking "Edit", it is unclear which properties are editable and which are not. I suggest greying out the uneditable fields, or using a different font, or perhaps moving them to the top of the page.
This table and its associated values will be undergoing revisions soon, and the "specification" field within it will become dynamic, so it is impractical to hardcode the field names and their titles. I have added 'title' annotations to the request and response schema to provide the field labels; I also added 'readOnly' annotations to the response to make it clear which fields are not editable via POST /hardware_product/:id or POST /hardware_product (see joyent/conch-api#1069)
You can obtain these schemas dynamically via GET /json_schema/<type>/<name> (see https://joyent.github.io/conch-api/modules/Conch::Route::JSONSchema), from which the page can be dynamically rendered. The content of these responses will not change between conch-api version number bumps, but the specification field's content can be determined via GET /json_schema/hardware_product/specification/latest and its content can be expected to change at any time. In all cases, GET /json_schema/* requests will respect caching headers (Last-Modified, If-Modified-Since, ETag etc).
The text was updated successfully, but these errors were encountered:
I am not familiar with the details of the framework he is using. There are many implementations listed at https://json-schema.org/implementations.html but I kept the schema simple enough that a tool may not even be needed.
The pages for viewing and editing hardware products have some issues.
This table and its associated values will be undergoing revisions soon, and the "specification" field within it will become dynamic, so it is impractical to hardcode the field names and their titles. I have added 'title' annotations to the request and response schema to provide the field labels; I also added 'readOnly' annotations to the response to make it clear which fields are not editable via
POST /hardware_product/:id
orPOST /hardware_product
(see joyent/conch-api#1069)You can obtain these schemas dynamically via
GET /json_schema/<type>/<name>
(see https://joyent.github.io/conch-api/modules/Conch::Route::JSONSchema), from which the page can be dynamically rendered. The content of these responses will not change between conch-api version number bumps, but the specification field's content can be determined viaGET /json_schema/hardware_product/specification/latest
and its content can be expected to change at any time. In all cases,GET /json_schema/*
requests will respect caching headers (Last-Modified, If-Modified-Since, ETag etc).The text was updated successfully, but these errors were encountered: