Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise Descriptions When OSCAL Content Returned to Client #90

Closed
5 tasks done
Tracked by #82
brian-comply0 opened this issue Mar 25, 2024 · 2 comments
Closed
5 tasks done
Tracked by #82

Revise Descriptions When OSCAL Content Returned to Client #90

brian-comply0 opened this issue Mar 25, 2024 · 2 comments
Assignees

Comments

@brian-comply0
Copy link
Contributor

brian-comply0 commented Mar 25, 2024

Description

As a developer issuing OSCAL REST API calls to retrieve OSCAL content, I need to understand how to request the OSCAL format I require.

Acceptance Criteria

  • For each model, the description for the following endpoints is updated as defined below
    • GET /[model-name]/{Identifier}
    • GET /[model-name]/{Identifier}/snapshot/{Identifier}
    • GET /profile/{Identifier}/resolved-catalog
    • GET /profile/{Identifier}/resolved-snapshot/{Identifier}

Description Content

The current description should be maintained for each of the four endpoints, with the following added to that content:

When processing this request, the implementation _must_ honor the `Accept` HTTP header for JSON, XML, and YAML. When `Accept` is set to:
- `application/json` or `application/oscal+json` return the OSCAL content in JSON format;
- `application/xml` (preferred by RFC 7303) or `text/xml` (deprecated by RFC 7303) or `application/oscal+xml` return the OSCAL content in XML format; or
- `application/yaml` or `text/yaml` return the OSCAL content in YAML format.

When returning the OSCAL content, the implementation _must_ set the `Content-type` header to:
- `application/json` when returning the OSCAL content in JSON format;
- `application/xml` when returning the OSCAL content in XML format; or
- `application/yaml` when return the OSCAL content in YAML format.

@brian-comply0 brian-comply0 changed the title Revise Descriptions When OSCAL Content is Returned Revise Descriptions When OSCAL Content Returned to Client Mar 25, 2024
@brian-comply0
Copy link
Contributor Author

@mpemy changes look good!

@brian-comply0
Copy link
Contributor Author

Full addressed in PR #72. Closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants