5a9abc73dd
While iterating on the next steps of using notes, it became clear that
several changes to the output and access methods for notes needed
enhancements. This change introduces a new way to access a note's URL
information via a new API/CLI, while removing the resolution of URLs
from the existing note output. This supports the concept of "builddata"
coming back with sizes of 800kb or more - which really can never work
out inline in other data, especially in cases where there is
multiplicity of the information across many items.
New API: GET /notedetails/{id}
CLI: shipyard get notedetails/{id} and/or shipyard get notedetails {id}
Returns the resolution of the URL for a note, outputting the raw info as
the response (not structured in a JSON response).
The CLI will attempt to minimally format the response if it has inline
\n characters by replacing them will real newlines in the output (if the
output-format is set to either cli or format. Raw format will be
returned as-is.
The existing notes responses are changed to not include the resolution
of the URL information inline, but rather provide the text:
Details at notedetails/{id}
The CLI will interpret this and present:
- Info available with 'describe notedetails/09876543210987654321098765'
This is an attempt to inform the user to access the note details that
way - luckily the API and CLI align on the term notedetails, as the word
details works well enough in the singular form presented by the CLI and
the plural form used by the API.
The ID returned is the unique id of the note (ULID format).
Notes that have no URL will return a 404 response from the API (and
an appropriately formatted value from the CLI).
This approach solves an issue beyond the large inline values from URLs;
providing a means to NOT resolve the URLs except in a one-at-a-time way.
Long lists of notes will no longer have the risk of long waits nor
needing of parallelization of retrieval of URLs for notes.
This change introduces an API-side sorting of notes by timestamp,
providing a chronological presentation of the information that may or
may not match the ULID or insertion ordering of the notes.
Additional feedback from peers about the output of noted indicated that
the CLI formatting of notes in general was in need of visual tuning. As
such, this change introduces changes to the formatting of the output
of notes from the CLI:
- Notes for describing an item will be presented with a more specific
header, e.g.: Action Notes: or Step Notes: instead of simply Notes.
- Tables with notes will change the header from "Notes" to "Footnotes"
give the user a better marker that the notes follow the current
table.
- Table footnotes will be presented in a table format similar to
the following, with headings matching the kind of note being
produced.
Step Footnotes Note
(1) > blah blah blah
> yakkity yakkity
(2) > stuff stuff stuff stuff stuff stuff stuff
stuff stuff stuff
- Info available with 'describe notedetails/...
> things things things
Change-Id: I1680505d5c555b2293419179ade995b0e8484e6d
122 lines
4.5 KiB
Python
122 lines
4.5 KiB
Python
# Copyright 2017 AT&T Intellectual Property. All other rights reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
import logging
|
|
|
|
import falcon
|
|
from shipyard_airflow.control.action.actions_api import ActionsResource
|
|
from shipyard_airflow.control.action.actions_control_api import \
|
|
ActionsControlResource
|
|
from shipyard_airflow.control.action.actions_id_api import ActionsIdResource
|
|
from shipyard_airflow.control.action.actions_steps_id_api import \
|
|
ActionsStepsResource
|
|
from shipyard_airflow.control.action.actions_steps_id_logs_api import \
|
|
ActionsStepsLogsResource
|
|
from shipyard_airflow.control.action.actions_validations_id_api import \
|
|
ActionsValidationsResource
|
|
from shipyard_airflow.control.af_monitoring.workflows_api import (
|
|
WorkflowIdResource,
|
|
WorkflowResource
|
|
)
|
|
from shipyard_airflow.control.base import BaseResource, ShipyardRequest
|
|
from shipyard_airflow.control.configdocs.configdocs_api import (
|
|
CommitConfigDocsResource,
|
|
ConfigDocsResource,
|
|
ConfigDocsStatusResource
|
|
)
|
|
from shipyard_airflow.control.configdocs.rendered_configdocs_api import \
|
|
RenderedConfigDocsResource
|
|
from shipyard_airflow.control.health import HealthResource
|
|
from shipyard_airflow.control.middleware.auth import AuthMiddleware
|
|
from shipyard_airflow.control.middleware.common_params import \
|
|
CommonParametersMiddleware
|
|
from shipyard_airflow.control.middleware.context import ContextMiddleware
|
|
from shipyard_airflow.control.middleware.logging_mw import LoggingMiddleware
|
|
from shipyard_airflow.control.notes.notedetails_api import NoteDetailsResource
|
|
from shipyard_airflow.control.status.status_api import StatusResource
|
|
from shipyard_airflow.errors import (AppError, default_error_serializer,
|
|
default_exception_handler)
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
def start_api():
|
|
middlewares = [
|
|
AuthMiddleware(),
|
|
ContextMiddleware(),
|
|
LoggingMiddleware(),
|
|
CommonParametersMiddleware()
|
|
]
|
|
control_api = falcon.API(
|
|
request_type=ShipyardRequest, middleware=middlewares)
|
|
|
|
control_api.add_route('/versions', VersionsResource())
|
|
|
|
# v1.0 of Shipyard API
|
|
v1_0_routes = [
|
|
# API for managing region data
|
|
('/health', HealthResource()),
|
|
('/actions', ActionsResource()),
|
|
('/actions/{action_id}', ActionsIdResource()),
|
|
('/actions/{action_id}/control/{control_verb}',
|
|
ActionsControlResource()),
|
|
('/actions/{action_id}/steps/{step_id}',
|
|
ActionsStepsResource()),
|
|
('/actions/{action_id}/steps/{step_id}/logs',
|
|
ActionsStepsLogsResource()),
|
|
('/actions/{action_id}/validations/{validation_id}',
|
|
ActionsValidationsResource()),
|
|
('/configdocs', ConfigDocsStatusResource()),
|
|
('/configdocs/{collection_id}', ConfigDocsResource()),
|
|
('/commitconfigdocs', CommitConfigDocsResource()),
|
|
('/notedetails/{note_id}', NoteDetailsResource()),
|
|
('/renderedconfigdocs', RenderedConfigDocsResource()),
|
|
('/workflows', WorkflowResource()),
|
|
('/workflows/{workflow_id}', WorkflowIdResource()),
|
|
('/site_statuses', StatusResource()),
|
|
]
|
|
|
|
# Set up the 1.0 routes
|
|
route_v1_0_prefix = '/api/v1.0'
|
|
for path, res in v1_0_routes:
|
|
route = '{}{}'.format(route_v1_0_prefix, path)
|
|
LOG.info(
|
|
'Adding route: %s Handled by %s',
|
|
route,
|
|
res.__class__.__name__
|
|
)
|
|
control_api.add_route(route, res)
|
|
|
|
# Error handlers (FILO handling)
|
|
control_api.add_error_handler(Exception, default_exception_handler)
|
|
control_api.add_error_handler(AppError, AppError.handle)
|
|
|
|
# built-in error serializer
|
|
control_api.set_error_serializer(default_error_serializer)
|
|
|
|
return control_api
|
|
|
|
|
|
class VersionsResource(BaseResource):
|
|
"""
|
|
Lists the versions supported by this API
|
|
"""
|
|
|
|
def on_get(self, req, resp):
|
|
resp.body = self.to_json({
|
|
'v1.0': {
|
|
'path': '/api/v1.0',
|
|
'status': 'stable'
|
|
}})
|
|
resp.status = falcon.HTTP_200
|