Skip to content
This repository has been archived by the owner on Jul 24, 2021. It is now read-only.

Commit

Permalink
fix documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
karenetheridge committed Jan 7, 2021
1 parent ea7abdf commit 1813ec9
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 35 deletions.
4 changes: 2 additions & 2 deletions docs/modules/Conch::Route::HardwareProduct.md
Expand Up @@ -83,7 +83,7 @@ Results in this data in `specification`, changing the data type at node `/foo/ba
- Requires system admin authorization
- Controller/Action: ["set\_specification" in Conch::Controller::HardwareProduct](../modules/Conch%3A%3AController%3A%3AHardwareProduct#set_specification)
- Request: after the update operation, the `specification` property must validate against
[common.json#/$defs/HardwareProductSpecification](../json-schema/common.json#/$defs/HardwareProductSpecification).
the schema available from `GET /json_schema/hardware_product/specification/latest`.
- Response: `204 No Content`

### `DELETE /hardware_product/:hardware_product_id_or_other/specification?path=:path_to_data`
Expand All @@ -93,7 +93,7 @@ parameter `path` as the JSON pointer to the data to be removed. All other proper
blob are left untouched.

After the delete operation, the `specification` property must validate against
[common.json#/$defs/HardwareProductSpecification](../json-schema/common.json#/$defs/HardwareProductSpecification).
the schema available from `GET /json_schema/hardware_product/specification/latest`.

- Requires system admin authorization
- Controller/Action: ["delete\_specification" in Conch::Controller::HardwareProduct](../modules/Conch%3A%3AController%3A%3AHardwareProduct#delete_specification)
Expand Down
14 changes: 3 additions & 11 deletions docs/modules/Conch::Route::JSONSchema.md
Expand Up @@ -56,6 +56,8 @@ Fetches the referenced JSON Schema document.

### `DELETE /json_schema/:json_schema_id`

### `DELETE /json_schema/:json_schema_type/:json_schema_name/:json_schema_version`

Deactivates the database entry for a single JSON Schema, rendering it unusable.
This operation is not permitted until all references from other documents have been removed,
exception of references using `.../latest` which will now resolve to a different document
Expand All @@ -70,19 +72,9 @@ If this JSON Schema was the latest of its series (`/json_schema/foo/bar/latest`)

### `GET /json_schema/:json_schema_type`

Gets meta information about all JSON Schemas in a particular type series.

Optionally accepts the following query parameter:

- `active_only` (default `0`): set to `1` to only query for JSON Schemas that have not been
deactivated.

- Controller/Action: ["get\_metadata" in Conch::Controller::JSONSchema](../modules/Conch%3A%3AController%3A%3AJSONSchema#get_metadata)
- Response: [response.json#/$defs/JSONSchemaDescriptions](../json-schema/response.json#/$defs/JSONSchemaDescriptions)

### `GET /json_schema/:json_schema_type/:json_schema_name`

Gets meta information about all JSON Schemas in a particular type and name series.
Gets meta information about all JSON Schemas in a particular type series, or a type and name series.

Optionally accepts the following query parameter:

Expand Down
4 changes: 2 additions & 2 deletions lib/Conch/Route/HardwareProduct.pm
Expand Up @@ -194,7 +194,7 @@ Results in this data in C<specification>, changing the data type at node C</foo/
=item * Controller/Action: L<Conch::Controller::HardwareProduct/set_specification>
=item * Request: after the update operation, the C<specification> property must validate against
F<common.yaml#/$defs/HardwareProductSpecification>.
the schema available from C<GET /json_schema/hardware_product/specification/latest>.
=item * Response: C<204 No Content>
Expand All @@ -207,7 +207,7 @@ parameter C<path> as the JSON pointer to the data to be removed. All other prope
blob are left untouched.
After the delete operation, the C<specification> property must validate against
F<common.yaml#/$defs/HardwareProductSpecification>.
the schema available from C<GET /json_schema/hardware_product/specification/latest>.
=over 4
Expand Down
23 changes: 3 additions & 20 deletions lib/Conch/Route/JSONSchema.pm
Expand Up @@ -149,6 +149,8 @@ Fetches the referenced JSON Schema document.
=head2 C<DELETE /json_schema/:json_schema_id>
=head2 C<DELETE /json_schema/:json_schema_type/:json_schema_name/:json_schema_version>
Deactivates the database entry for a single JSON Schema, rendering it unusable.
This operation is not permitted until all references from other documents have been removed,
exception of references using C<.../latest> which will now resolve to a different document
Expand All @@ -169,28 +171,9 @@ C<.../latest> link will now resolve to an earlier version in the series.
=head2 C<GET /json_schema/:json_schema_type>
Gets meta information about all JSON Schemas in a particular type series.
Optionally accepts the following query parameter:
=over 4
=item * C<active_only> (default C<0>): set to C<1> to only query for JSON Schemas that have not been
deactivated.
=back
=over 4
=item * Controller/Action: L<Conch::Controller::JSONSchema/get_metadata>
=item * Response: F<response.yaml#/$defs/JSONSchemaDescriptions>
=back
=head2 C<GET /json_schema/:json_schema_type/:json_schema_name>
Gets meta information about all JSON Schemas in a particular type and name series.
Gets meta information about all JSON Schemas in a particular type series, or a type and name series.
Optionally accepts the following query parameter:
Expand Down

0 comments on commit 1813ec9

Please sign in to comment.