Merge ~lloydwaltersj/maas:update-openApi-licence-field into maas:master

Proposed by Jack Lloyd-Walters
Status: Merged
Approved by: Jack Lloyd-Walters
Approved revision: 810e62165cd8e94a7cac2c19ec7368a03ef1abaa
Merge reported by: MAAS Lander
Merged at revision: not available
Proposed branch: ~lloydwaltersj/maas:update-openApi-licence-field
Merge into: maas:master
Diff against target: 21 lines (+9/-1)
1 file modified
src/maasserver/api/doc_oapi.py (+9/-1)
Reviewer Review Type Date Requested Status
MAAS Lander Approve
Alexsander de Souza Approve
Review via email: mp+427573@code.launchpad.net

Commit message

Update OpenAPI info field to include MAAS licence

To post a comment you must log in.
Revision history for this message
Alexsander de Souza (alexsander-souza) wrote :

+1

review: Approve
Revision history for this message
MAAS Lander (maas-lander) wrote :

UNIT TESTS
-b update-openApi-licence-field lp:~lloydwaltersj/maas/+git/maas into -b master lp:~maas-committers/maas

STATUS: SUCCESS
COMMIT: 810e62165cd8e94a7cac2c19ec7368a03ef1abaa

review: Approve
Revision history for this message
Anton Troyanov (troyanov) wrote :

Oh, probably commit message should be OpenAPI.
Noticed that when was searching for OpenAI in my mailbox :)

Revision history for this message
Jack Lloyd-Walters (lloydwaltersj) wrote :

I didn't even notice the spelling error!

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/src/maasserver/api/doc_oapi.py b/src/maasserver/api/doc_oapi.py
2index 271000b..ca22d14 100644
3--- a/src/maasserver/api/doc_oapi.py
4+++ b/src/maasserver/api/doc_oapi.py
5@@ -83,7 +83,15 @@ def get_api_endpoint():
6 """Return the API endpoint"""
7 description = {
8 "openapi": "3.0.0",
9- "info": {"title": "MAAS HTTP API", "version": "2.0.0"},
10+ "info": {
11+ "title": "MAAS HTTP API",
12+ "description": "This is the documentation for the API that lets you control and query MAAS. You can find out more about MAAS at [https://maas.io/](https://maas.io/).",
13+ "version": "2.0.0",
14+ "license": {
15+ "name": "GNU Affero General Public License version 3",
16+ "url": "https://www.gnu.org/licenses/agpl-3.0.en.html",
17+ },
18+ },
19 "paths": _render_oapi_paths(),
20 "externalDocs": {
21 "description": "MAAS API documentation",

Subscribers

People subscribed via source and target branches