Skip to content

Commit b3bd4d8

Browse files
momo3404aaronskiba
authored andcommitted
Add v2 API documentation to API Access page
1 parent af44c49 commit b3bd4d8

2 files changed

Lines changed: 11 additions & 1 deletion

File tree

app/views/devise/registrations/_v2_api_token.html.erb

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<%# locals: user, token %>
2+
<% api_wikis = Rails.configuration.x.application.api_documentation_urls %>
23

34
<div id="v2-api-token" class="card mb-4">
45
<div class="card-heading">
@@ -43,6 +44,14 @@
4344
disabled: token.present?,
4445
data: { remote: true, url: api_v2_internal_user_access_token_path, method: :post } %>
4546
</div>
47+
<div class="form-group mb-3 col-xs-12">
48+
<%= label_tag(:api_information, _('Documentation'), class: 'form-label') %>
49+
<br>
50+
<%= sanitize(_('See the <a href="%{api_v2_wiki}">documentation for v2</a> for more details on the API.') %
51+
{ api_v2_wiki: api_wikis[:v2] },
52+
attributes: %w[href]
53+
)%>
54+
</div>
4655
<% else %>
4756
<div class="alert alert-warning">
4857
<%= _("V2 API token service is currently unavailable. Please contact us for help.") %>

config/initializers/_dmproadmap.rb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,8 @@ class Application < Rails::Application
7979
# The link to the API documentation - used in emails about the API
8080
config.x.application.api_documentation_urls = {
8181
v0: 'https://github.com/DMPRoadmap/roadmap/wiki/API-V0-Documentation',
82-
v1: 'https://github.com/DMPRoadmap/roadmap/wiki/API-V1-Documentation'
82+
v1: 'https://github.com/DMPRoadmap/roadmap/wiki/API-v1-Documentation',
83+
v2: 'https://github.com/DMPRoadmap/roadmap/wiki/API-v2-Documentation'
8384
}
8485
# The links that appear on the home page. Add any number of links
8586
config.x.application.welcome_links = [

0 commit comments

Comments
 (0)