Skip to content

Commit

Permalink
openapi: fix paths
Browse files Browse the repository at this point in the history
According to my read of the
[spec](https://swagger.io/specification/#pathsObject), the paths need to
be prefixed with slashes.

This should fix #1280.

Signed-off-by: Hank Donnay <hdonnay@redhat.com>
  • Loading branch information
hdonnay committed Jun 4, 2021
1 parent 9ce2af3 commit 5d03223
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 13 deletions.
12 changes: 6 additions & 6 deletions Documentation/reference/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ fetch('/notifier/api/v1/notification/{notification_id}',

```

`DELETE notifier/api/v1/notification/{notification_id}`
`DELETE /notifier/api/v1/notification/{notification_id}`

Issues a delete of the provided notification id and all associated
notifications. After this delete clients will no longer be able to
Expand Down Expand Up @@ -192,7 +192,7 @@ fetch('/notifier/api/v1/notification/{notification_id}',

```

`GET notifier/api/v1/notification/{notification_id}`
`GET /notifier/api/v1/notification/{notification_id}`

By performing a GET with a notification_id as a path parameter, the
client will retrieve a paginated response of notification objects.
Expand Down Expand Up @@ -372,7 +372,7 @@ fetch('/indexer/api/v1/index_report',

```

`POST indexer/api/v1/index_report`
`POST /indexer/api/v1/index_report`

By submitting a Manifest object to this endpoint Clair will fetch the
layers, scan each layer's contents, and provide an index of discovered
Expand Down Expand Up @@ -536,7 +536,7 @@ fetch('/indexer/api/v1/index_report/{manifest_hash}',

```

`GET indexer/api/v1/index_report/{manifest_hash}`
`GET /indexer/api/v1/index_report/{manifest_hash}`

Given a Manifest's content addressable hash an IndexReport will
be retrieved if exists.
Expand Down Expand Up @@ -683,7 +683,7 @@ fetch('/indexer/api/v1/index_state',

```

`GET indexer/api/v1/index_state`
`GET /indexer/api/v1/index_state`

The index state endpoint returns a json structure indicating the
indexer's internal configuration state.
Expand Down Expand Up @@ -784,7 +784,7 @@ fetch('/matcher/api/v1/vulnerability_report/{manifest_hash}',

```

`GET matcher/api/v1/vulnerability_report/{manifest_hash}`
`GET /matcher/api/v1/vulnerability_report/{manifest_hash}`

Given a Manifest's content addressable hash a VulnerabilityReport
will be created. The Manifest **must** have been Indexed first
Expand Down
Loading

0 comments on commit 5d03223

Please sign in to comment.