Skip to content

Commit

Permalink
chore: 📝 updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
miggi92 committed Apr 24, 2024
1 parent 406819f commit a287bde
Show file tree
Hide file tree
Showing 28 changed files with 945 additions and 403 deletions.
8 changes: 0 additions & 8 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,3 @@ updates:
labels:
- "npm"
- "dependencies"
# Maintain dependencies for pip
- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "weekly"
labels:
- "pip"
- "dependencies"
12 changes: 0 additions & 12 deletions .github/workflows/update_doc_template.yml

This file was deleted.

160 changes: 118 additions & 42 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -1,51 +1,127 @@
import { defineConfig } from 'vitepress'
import { withMermaid } from "vitepress-plugin-mermaid";

import { version } from "../../package.json";

// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "ABAP OData Framework",
lang: 'en-US',
base: '/odata-fw/',
description: "A odata framework for a SAP System. ",
head: [['link', { rel: 'icon', href: '../assets/favicon.ico' }]],
sitemap: {
hostname: "https://miggi92.github.io/odata-fw/"
},
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
nav: [
{ text: 'Home', link: '/' },
{ text: 'Documentation', link: '/documentation/' }
],
search: {
provider: 'local',
options: {
_render(src, env, md) {
const html = md.render(src, env)
if (env.frontmatter?.title)
return md.render(`# ${env.frontmatter.title}`) + html
return html
export default
// withMermaid(

defineConfig({
title: "ABAP OData Framework",
lang: 'en-US',
base: '/odata-fw/',
description: "A odata framework for a SAP System. ",
head: [['link', { rel: 'icon', href: '../assets/favicon.ico' }]],
lastUpdated: true,
sitemap: {
hostname: "https://miggi92.github.io/odata-fw/"
},
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
nav: nav(),
outline: [2, 6],
search: {
provider: 'local',
options: {
_render(src, env, md) {
const html = md.render(src, env)
if (env.frontmatter?.title)
return md.render(`# ${env.frontmatter.title}`) + html
return html
}
}
},
lastUpdated: {
text: 'Updated at',
formatOptions: {
dateStyle: 'full',
timeStyle: 'medium'
}
},

sidebar: {
"/documentation/": sidebarDocumentation(),
},
logo: '../assets/odata_fw_logo_transparent.png',

socialLinks: [
{ icon: 'github', link: 'https://github.com/miggi92/odata-fw' }
],
footer: {
message: 'Released under the MIT License.',
copyright: 'Copyright © 2019 - present miggi92'
}
},
locales: {
root: {
label: 'English',
lang: 'en'
},
}
}
// )
);

sidebar: [
{
text: 'Documentation',
items: [
{ text: 'Documentation', link: '/documentation/' },
{ text: 'Creating a service', link: '/documentation/Creating-a-service' },
{ text: 'DPC boilerplate code', link: '/documentation/DPC-boilerplate-code' }
]
}
],
logo: '../assets/odata_fw_logo_transparent.png',
function nav() {
return [
{ text: 'Home', link: '/' },
{ text: 'Documentation', link: '/documentation/', activeMatch: "/documentation/" },
{
text: version,
items: [
{
text: 'Changelog',
link: 'https://github.com/miggi92/odata-fw/blob/master/CHANGELOG.md'
},
{
text: 'Contributing',
link: 'https://github.com/miggi92/odata-fw/blob/master/CONTRIBUTING.md'
}
]
},
];
}

socialLinks: [
{ icon: 'github', link: 'https://github.com/miggi92/odata-fw' }
],
footer: {
message: 'Released under the MIT License.',
copyright: 'Copyright © 2019 - present miggi92'
function sidebarDocumentation() {
return [
{
text: "Documentation",
collapsible: true,
items: [
{ text: 'Creating a service', link: '/documentation/Creating-a-service' },
{ text: 'DPC boilerplate code', link: '/documentation/DPC-boilerplate-code' }
],
},
{
text: 'Development Objects',
link: '/documentation/dev-objects/',
collapsible: true,
items: [
{ text: 'Documentation', link: '/documentation/dev-objects/' }, {
text: 'Classes', link: '/documentation/dev-objects/classes/', items: [
{ text: 'ZCL_ODATA_DATA_PROVIDER', link: '/documentation/dev-objects/classes/ZCL_ODATA_DATA_PROVIDER' },
{ text: 'ZCL_ODATA_DOCUMENTS', link: '/documentation/dev-objects/classes/ZCL_ODATA_DOCUMENTS' },
{ text: 'ZCL_ODATA_FW_CONTROLLER', link: '/documentation/dev-objects/classes/ZCL_ODATA_FW_CONTROLLER' },
{ text: 'ZCL_ODATA_FW_CUST_DPC', link: '/documentation/dev-objects/classes/ZCL_ODATA_FW_CUST_DPC' },
{ text: 'ZCL_ODATA_FW_CUST', link: '/documentation/dev-objects/classes/ZCL_ODATA_FW_CUST' },
{ text: 'ZCL_ODATA_FW_MPC', link: '/documentation/dev-objects/classes/ZCL_ODATA_FW_MPC' },
{ text: 'ZCL_ODATA_MAIN', link: '/documentation/dev-objects/classes/ZCL_ODATA_MAIN' },
{ text: 'ZCL_ODATA_UTILS', link: '/documentation/dev-objects/classes/ZCL_ODATA_UTILS' },
{ text: 'ZCL_ODATA_VALUE_HELP', link: '/documentation/dev-objects/classes/ZCL_ODATA_VALUE_HELP' },
{
text: 'Annotations', link: '/documentation/dev-objects/classes/annotations/', items: [
{ text: 'ZCL_ODATA_ANNOTATION_COMMON', link: '/documentation/dev-objects/classes/annotations/ZCL_ODATA_ANNOTATION_COMMON' },
{ text: 'ZCL_ODATA_ANNOTATION_SHLP', link: '/documentation/dev-objects/classes/annotations/ZCL_ODATA_ANNOTATION_SHLP' },
]
},
]
}, {
text: 'DDIC objects', link: '/documentation/dev-objects/ddic/', collapsible: true
},
{
text: 'SAP objects', link: '/documentation/dev-objects/sap-objects/'
}]
}
}
})
];
}
2 changes: 1 addition & 1 deletion docs/documentation/Creating-a-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ PUBLIC SECTION.
METHODS define REDEFINITION.
```

Next we add the OData framework by calling the "define_mpc" method of the framework class ([ZCL_ODATA_FW_CONTROLLER](../dev-objects/classes/ZCL_ODATA_FW_CONTROLLER)). Notice, that 'Z_MY_PROJECT' is the namespace, that we need to use in the framework view cluster.
Next we add the OData framework by calling the "define_mpc" method of the framework class ([ZCL_ODATA_FW_CONTROLLER](./dev-objects/classes/ZCL_ODATA_FW_CONTROLLER)). Notice, that 'Z_MY_PROJECT' is the namespace, that we need to use in the framework view cluster.

```abap
METHOD define.
Expand Down
2 changes: 1 addition & 1 deletion docs/documentation/OData-Customizing.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ To define entities you need to select the namespace you want to define an entity

![define entity](./attachments/cust_define_entity.png)

The classes added to the customizing should inherit from "[ZCL_ODATA_MAIN](../dev-objects/classes/ZCL_ODATA_MAIN)" class.
The classes added to the customizing should inherit from "[ZCL_ODATA_MAIN](./dev-objects/classes/ZCL_ODATA_MAIN)" class.

## Define Properties

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: ZCL_ODATA_DATA_PROVIDER

# {{ $frontmatter.title }}

This class contains the data provider classes for the odata service. Every data provider needs to inherit from the [[ZCL_ODATA_MAIN]] class.
This class contains the data provider classes for the odata service. Every data provider needs to inherit from the [ZCL_ODATA_MAIN](./ZCL_ODATA_MAIN) class.

## Methods

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ This method reads out the stream of the document. The stream contains the binary

#### get_file

This method reads out the file data and returns it as structure of type [[ZODATA_FILE]].
It is called within the method [[#get_stream]] and should be redefined in the inherited class.
This method reads out the file data and returns it as structure of type [ZODATA_FILE](./ddic/structures/ZODATA_FILE).
It is called within the method [get_strean](#get_stream) and should be redefined in the inherited class.

#### get_mime_type_from_type

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
---
description: Framework customizing class
title: ZCL_ODATA_FW_CUST
tags:
- customizing
date created: Friday, September 8th 2023, 9:50:10 am
date modified: Friday, September 8th 2023, 10:01:05 am
---

# {{ $frontmatter.title }}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
---
title: ZCL_ODATA_FW_CUST_DPC
description: DPC Class
date created: Tuesday, September 5th 2023, 11:14:46 pm
date modified: Friday, September 8th 2023, 10:01:11 am
tags:
- dpc
- customizing
---
# {{ $frontmatter.title }}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
---
title: ZCL_ODATA_FW_MPC
description: MPC Framework class
tags:
- mpc
- customizing
date created: Tuesday, September 5th 2023, 11:07:54 pm
date modified: Friday, September 8th 2023, 10:01:24 am
---
# {{ $frontmatter.title }}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
---
title: ZCL_ODATA_MAIN
description: Class ZCL_ODATA_MAIN
date created: Wednesday, August 23rd 2023, 6:18:18 pm
date modified: Friday, September 8th 2023, 9:57:18 am
---
# {{ $frontmatter.title }}

This abstract class is the blueprint for every entity class used by this framework.

## [[-IWBEP-IF_MGW_APPL_SRV_RUNTIME|/IWBEP/IF_MGW_APPL_SRV_RUNTIME]]
## [/IWBEP/IF_MGW_APPL_SRV_RUNTIME](../sap-objects/-IWBEP-IF_MGW_APPL_SRV_RUNTIME)

Every method of the "/iwbep/if_mgw_appl_srv_runtime" interface can be redefined in the sub class. Only the methods that you really need have to be redefined.

Expand Down Expand Up @@ -45,9 +43,9 @@ This method applies dynamic filtering, pagination and sorting to the current ent
The options can also be called separate.

- [[#PAGINATE_COLLECTION]]
- [[#FILTER_COLLECTION]]
- [[#ORDER_COLLECTION]]
- [PAGINATE_COLLECTION](#PAGINATE_COLLECTION)
- [FILTER_COLLECTION](#FILTER_COLLECTION)
- [ORDER_COLLECTION](#ORDER_COLLECTION)

### PAGINATE_COLLECTION

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,29 +1,25 @@
---
description: Class for value help entity
title: ZCL_ODATA_VALUE_HELP
date created: Friday, September 8th 2023, 9:50:10 am
date modified: Friday, September 8th 2023, 10:00:20 am
tags:
- entity
---

# {{ $frontmatter.title }}

This class is used for the [[global value help]] entity.
This class inherits from [[ZCL_ODATA_MAIN]].
This class is used for the [global value help](../../global/global-value-help) entity.
This class inherits from [ZCL_ODATA_MAIN](./ZCL_ODATA_MAIN).

## Methods

### Public

#### get_entityset

This method is redefined from the super class with the interface [[-IWBEP-IF_MGW_APPL_SRV_RUNTIME|/IWBEP/IF_MGW_APPL_SRV_RUNTIME]].
This method is redefined from the super class with the interface [/IWBEP/IF_MGW_APPL_SRV_RUNTIME](../sap-objects/-IWBEP-IF_MGW_APPL_SRV_RUNTIME).
This method reads out the values for the value help and returns them.

#### get_entity

This method is redefined from the super class with the interface [[-IWBEP-IF_MGW_APPL_SRV_RUNTIME|/IWBEP/IF_MGW_APPL_SRV_RUNTIME]].
This method is redefined from the super class with the interface [/IWBEP/IF_MGW_APPL_SRV_RUNTIME](../sap-objects/-IWBEP-IF_MGW_APPL_SRV_RUNTIME).
This method returns the value help for a specific value.

### Private
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
---
title: ZCL_ODATA_ANNOTATION_COMMON
description: Common annotation class
date created: Tuesday, September 5th 2023, 11:17:29 pm
date modified: Tuesday, September 5th 2023, 11:18:35 pm
tags:
- annotation
---
# {{ $frontmatter.title }}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
---
title: ZCL_ODATA_ANNOTATION_SHLP
description: Search help annotations
date created: Tuesday, September 5th 2023, 11:18:38 pm
date modified: Tuesday, September 5th 2023, 11:44:25 pm
tags:
- annotation
---
# {{ $frontmatter.title }}

Inheritates from [[ZCL_ODATA_ANNOTATION_COMMON]]. Adds the search help annotations to the odata service.
Inheritates from [ZCL_ODATA_ANNOTATION_COMMON](./ZCL_ODATA_ANNOTATION_COMMON). Adds the search help annotations to the odata service.

## Methods

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
---
title: Annotations
description: Annotation classes
date created: Tuesday, September 5th 2023, 11:16:53 pm
date modified: Tuesday, September 5th 2023, 11:47:16 pm
tags:
- annotation
---
# {{ $frontmatter.title }}

Expand Down
Loading

0 comments on commit a287bde

Please sign in to comment.